.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\"
.\" Copyright 1989 AT&T.
.\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
.\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
.\" Copyright 2016 Joyent, Inc.
.\"
.TH PUTENV 3C "Jun 22, 2016"
.SH NAME
putenv \- change or add value to environment
.SH SYNOPSIS
.LP
.nf
#include <stdlib.h>

\fBint\fR \fBputenv\fR(\fBchar *\fR\fIstring\fR);
.fi

.SH DESCRIPTION
.LP
The \fBputenv()\fR function makes the value of the environment variable
\fIname\fR equal to \fIvalue\fR by altering an existing variable or creating a
new one. In either case, the string pointed to by \fIstring\fR becomes part of
the environment, so altering the string will change the environment.
.sp
.LP
The \fIstring\fR argument points to a string of the form
\fIname\fR\fB=\fR\fIvalue\fR. The space used by \fIstring\fR is no longer used
once a new string-defining \fIname\fR is passed to \fBputenv()\fR. If
there is no equals sign (\fB=\fR) present as a separator, then
\fIstring\fR is treated as the \fIname\fR of an environment variable to
remove from the environment, as though \fBunsetenv\fR(3C) had been
called.
.sp
.LP
The \fBputenv()\fR function uses \fBmalloc\fR(3C) to enlarge the environment.
.sp
.LP
After \fBputenv()\fR is called, environment variables are not in alphabetical
order.
.SH RETURN VALUES
.LP
Upon successful completion, \fBputenv()\fR returns 0. Otherwise, it returns a
non-zero value and sets \fBerrno\fR to indicate the error.
.SH ERRORS
.LP
The \fBputenv()\fR function may fail if:
.sp
.ne 2
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
Insufficient memory was available.
.RE

.SH USAGE
.LP
The \fBputenv()\fR function can be safely called from multithreaded programs.
Caution must be exercised when using this function and \fBgetenv\fR(3C) in
multithreaded programs. These functions examine and modify the environment
list, which is shared by all threads in a program.  The system prevents the
list from being accessed simultaneously by two different threads.  It does not,
however, prevent two threads from successively accessing the environment list
using \fBputenv()\fR or \fBgetenv()\fR.
.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	Safe
.TE

.SH SEE ALSO
.LP
.BR exec (2),
.BR getenv (3C),
.BR malloc (3C),
.BR attributes (7),
.BR environ (7),
.BR standards (7)
.SH WARNINGS
.LP
The \fIstring\fR argument should not be an automatic variable.  It should be
declared static if it is declared within a function because it cannot be
automatically declared. A potential error is to call \fBputenv()\fR with a
pointer to an automatic variable as the argument and to then exit the calling
function while \fIstring\fR is still part of the environment.
